Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(proposal): Dogfooding of trestle in the oscal-compass community #58

Merged
merged 8 commits into from
Aug 7, 2024

Conversation

butler54
Copy link
Contributor

This is a proposal to use trestle within the proposals process.

The intent that this should be debated on two levels:

  1. The validity of doing so

  2. The document structure of the proposal, such that it can be used as the actual template if approved.

@jpower432 jpower432 self-requested a review July 31, 2024 12:51
@jpower432 jpower432 self-assigned this Jul 31, 2024
Copy link
Member

@jflowers jflowers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great!

Copy link
Member

@jpower432 jpower432 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@butler54 I completely agree that using trestle here is a good opportunity. I want to link the CNCF design proposal example. I think we could tailor this for the template. What you have already lines up well. I would recommend adding Goals, Non-Goals, and Impact/Key Questions.

Editing my recommendation:
You already have Definition of Done, so maybe adding Scope to communicate Non-Goals. WDYT?

Signed-off-by: Chris Butler <[email protected]>
@butler54
Copy link
Contributor Author

butler54 commented Aug 2, 2024

@butler54 I completely agree that using trestle here is a good opportunity. I want to link the CNCF design proposal example. I think we could tailor this for the template. What you have already lines up well. I would recommend adding Goals, Non-Goals, and Impact/Key Questions.

Editing my recommendation: You already have Definition of Done, so maybe adding Scope to communicate Non-Goals. WDYT?

@jpower432 / @jflowers - I've made an incremental change, however, looking at the CNCF design proposal template. I think we should faithfully recreate it. Why: It gives us a bit of a springboard to a long term goal: trestle, by default, is expected by the CNCF to be use used to enforce templates (maybe I am being ambitious).

if we agree this is a good idea moving forward I'll translate it into the proposal template @jpower432's referenced with a few tweaks (I would like to see the metadata stored as a a yaml header).

@jpower432
Copy link
Member

jpower432 commented Aug 2, 2024

if we agree this is a good idea moving forward I'll translate it into the proposal template @jpower432's referenced with a few tweaks (I would like to see the metadata stored as a a yaml header).

@butler54 I am on board with this. The template we have is almost as comprehensive as the CNCF design proposal template so we might as well align on the naming of the sections for consistency/reuse. Another example of a good comprehensive template is Kubernetes Enhancements.

@jflowers
Copy link
Member

jflowers commented Aug 2, 2024

I like it! I think it's a good ambition.

@butler54 butler54 marked this pull request as draft August 4, 2024 09:12
@butler54 butler54 marked this pull request as ready for review August 5, 2024 00:55
@butler54
Copy link
Contributor Author

butler54 commented Aug 5, 2024

Okay this should be good to review now / ready to roll.

As mentioned in the document the project will need to be updated to mandate trestle author docs validate passing.

Copy link
Member

@jpower432 jpower432 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Two nits/non-blocking comments on the workflow.

@butler54
Copy link
Contributor Author

butler54 commented Aug 7, 2024

It's good to be merged now based on your feedback.

@jpower432 jpower432 merged commit 6619e0c into oscal-compass:main Aug 7, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants